FoxitPDFSDKPython3.SearchOption类 参考

继承自 FoxitPDFSDKPython3._object .

Public 成员函数
def	SearchOption ()
	构造函数。
def	SearchOption (is_whole_word, is_case_sensitive, is_search_bookmarks, is_search_in_marup, is_search_in_attachments, is_ignore_accents, is_proximity, is_stemming, is_ignore_full_width, max_docs, word_matching, is_search_doc_text)
	构造函数，带参数。 更多...
def	SearchOption (search_option)
	拷贝构造函数。 更多...
def	Set (is_whole_word, is_case_sensitive, is_search_bookmarks, is_search_in_marup, is_search_in_attachments, is_ignore_accents, is_proximity, is_stemming, is_ignore_full_width, max_docs, word_matching, is_search_doc_text)
	设置值。 更多...

静态 Public 属性
	e_WordMatchingMatchAllWords = _fsdk.SearchOption_e_WordMatchingMatchAllWords
	单词匹配：匹配所有单词。
	e_WordMatchingMatchAnyWord = _fsdk.SearchOption_e_WordMatchingMatchAnyWord
	单词匹配：匹配任意单词。
	e_WordMatchingMatchPhrase = _fsdk.SearchOption_e_WordMatchingMatchPhrase
	单词匹配：匹配短语。
	is_case_sensitive = _fsdk.SearchOption_is_case_sensitive
	指定搜索查询是否区分大小写。默认值：false。
	is_ignore_accents = _fsdk.SearchOption_is_ignore_accents
	指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。
	is_ignore_full_width = _fsdk.SearchOption_is_ignore_full_width
	指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。
	is_proximity = _fsdk.SearchOption_is_proximity
	指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。
	is_search_bookmarks = _fsdk.SearchOption_is_search_bookmarks
	指定是否在书签中搜索查询。默认值：false。
	is_search_doc_text = _fsdk.SearchOption_is_search_doc_text
	指定是否在文档文本中搜索查询。默认值：true。
	is_search_in_attachments = _fsdk.SearchOption_is_search_in_attachments
	指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。
	is_search_in_markup = _fsdk.SearchOption_is_search_in_markup
	指定是否在标记（注释）中搜索查询。默认值：false。
	is_stemming = _fsdk.SearchOption_is_stemming
	指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。
	is_whole_word = _fsdk.SearchOption_is_whole_word
	指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。
	max_docs = _fsdk.SearchOption_max_docs
	作为搜索查询一部分返回的文档的最大数量。默认值：100。
	word_matching = _fsdk.SearchOption_word_matching
	查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 FoxitPDFSDKPython3.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。

详细描述

此类表示搜索选项。

构造及析构函数说明

SearchOption() [1/2]

def FoxitPDFSDKPython3.SearchOption.SearchOption	(		is_whole_word,
			is_case_sensitive,
			is_search_bookmarks,
			is_search_in_marup,
			is_search_in_attachments,
			is_ignore_accents,
			is_proximity,
			is_stemming,
			is_ignore_full_width,
			max_docs,
			word_matching,
			is_search_doc_text
	)

构造函数，带参数。

参数

[in]	is_whole_word	指定搜索是否仅查找查询中指定的完整单词的出现。
[in]	is_case_sensitive	指定搜索查询是否区分大小写。
[in]	is_search_bookmarks	指定是否在书签中搜索查询。
[in]	is_search_in_attachments	指定是否在基础文档的任何PDF文件附件中进行搜索。
[in]	is_ignore_accents	指定在搜索查询词时是否忽略重音符号和变音符号。
[in]	is_proximity	指定在执行包含AND布尔子句的搜索时，搜索查询是否会在结果排名中反映单词的接近度。
[in]	is_stemming	指定在执行搜索时，搜索查询是否会考虑单词的词干变化（例如，run、runs、running）。
[in]	is_ignore_full_width	指定文档中的全角和半角字符是否完全匹配搜索查询。
[in]	max_docs	作为搜索查询的一部分返回的文档的最大数量。
[in]	word_matching	查询中的单个单词如何与文档中的单词匹配。
[in]	is_search_doc_text	指定是否在文档文本中搜索查询。

SearchOption() [2/2]

def FoxitPDFSDKPython3.SearchOption.SearchOption

(

search_option

)

拷贝构造函数。

参数

[in]

search_option

另一个搜索选项对象。

成员函数说明

Set()

def FoxitPDFSDKPython3.SearchOption.Set	(		is_whole_word,
			is_case_sensitive,
			is_search_bookmarks,
			is_search_in_marup,
			is_search_in_attachments,
			is_ignore_accents,
			is_proximity,
			is_stemming,
			is_ignore_full_width,
			max_docs,
			word_matching,
			is_search_doc_text
	)

设置值。

参数

[in]	is_whole_word	指定搜索是否仅查找查询中指定的完整单词的出现。
[in]	is_case_sensitive	指定搜索查询是否区分大小写。
[in]	is_search_bookmarks	指定是否在书签中搜索查询。
[in]	is_search_in_attachments	指定是否在基础文档的任何PDF文件附件中进行搜索。
[in]	is_ignore_accents	指定在搜索查询词时是否忽略重音符号和变音符号。
[in]	is_proximity	指定在执行包含AND布尔子句的搜索时，搜索查询是否会在结果排名中反映单词的接近度。
[in]	is_stemming	指定在执行搜索时，搜索查询是否会考虑单词的词干变化（例如，run、runs、running）。
[in]	is_ignore_full_width	指定文档中的全角和半角字符是否精确匹配搜索查询。
[in]	max_docs	作为搜索查询结果返回的文档的最大数量。
[in]	word_matching	查询中的单个单词将如何与文档中的单词匹配。
[in]	is_search_doc_text	指定是否在文档文本中搜索查询。

返回

无。